home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1664.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.1 KB  |  127 lines
  1. 166
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. WindowList 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baWindowList returns a list of the handles of open windows. These handles can 
  20. --- RECORDSEPARATOR ---
  21. then be used in other window management functions.
  22. --- RECORDSEPARATOR ---
  23.  
  24. --- RECORDSEPARATOR ---
  25. Usage:
  26. --- RECORDSEPARATOR ---
  27.  
  28. --- RECORDSEPARATOR ---
  29. Result = baWindowList( Class/Creator, Caption, MatchCaption )
  30. --- RECORDSEPARATOR ---
  31.  
  32. --- RECORDSEPARATOR ---
  33. Arguments:
  34. --- RECORDSEPARATOR ---
  35.  
  36. --- RECORDSEPARATOR ---
  37. String, String, Integer. 
  38. --- RECORDSEPARATOR ---
  39. On
  40. --- RECORDSEPARATOR ---
  41.  Windows
  42. --- RECORDSEPARATOR ---
  43. , Class is the class name of the window. 
  44. --- RECORDSEPARATOR ---
  45. On
  46. --- RECORDSEPARATOR ---
  47.  Macintosh
  48. --- RECORDSEPARATOR ---
  49. , Creator it is the creator type of the application. 
  50. --- RECORDSEPARATOR ---
  51. Caption is the Caption of the windows to find. 
  52. --- RECORDSEPARATOR ---
  53. If MatchCaption is true, then Caption must match the window caption exactly (apart 
  54. --- RECORDSEPARATOR ---
  55. from case). If it is false, then any window which contains Caption will be returned. If 
  56. --- RECORDSEPARATOR ---
  57. Caption is an empty string, then MatchCaption is ignored. 
  58. --- RECORDSEPARATOR ---
  59. The function can use either or both Class/Creator and Caption arguments. If one of 
  60. --- RECORDSEPARATOR ---
  61. the arguments is blank, then only the other argument will be used in searching for 
  62. --- RECORDSEPARATOR ---
  63. the windows.
  64. --- RECORDSEPARATOR ---
  65.  
  66. --- RECORDSEPARATOR ---
  67. Returns:
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. List (Xtra) or String (UCD). 
  72. --- RECORDSEPARATOR ---
  73. Returns a list or string of all matching window handles.
  74. --- RECORDSEPARATOR ---
  75.  
  76. --- RECORDSEPARATOR ---
  77. Examples:
  78. --- RECORDSEPARATOR ---
  79.  
  80. --- RECORDSEPARATOR ---
  81. Director: 
  82. --- RECORDSEPARATOR ---
  83. set WndList = baWindowList( "" , "Netscape" , false ) 
  84. --- RECORDSEPARATOR ---
  85. --
  86. --- RECORDSEPARATOR ---
  87.  return list of all windows 
  88. --- RECORDSEPARATOR ---
  89. with a caption containing "Netscape"
  90. --- RECORDSEPARATOR ---
  91.  
  92. --- RECORDSEPARATOR ---
  93. Authorware: 
  94. --- RECORDSEPARATOR ---
  95. WndList := baWindowList( "Notepad" , "" , false ) 
  96. --- RECORDSEPARATOR ---
  97. --
  98. --- RECORDSEPARATOR ---
  99.  return list of all Notepad 
  100. --- RECORDSEPARATOR ---
  101. windows
  102. --- RECORDSEPARATOR ---
  103.  
  104. --- RECORDSEPARATOR ---
  105. Notes:
  106. --- RECORDSEPARATOR ---
  107.  
  108. --- RECORDSEPARATOR ---
  109. The return for the UCD version is a string with each window handle on a separate 
  110. --- RECORDSEPARATOR ---
  111. line. You can use the Authorware GetLine function to retrieve each window handle. 
  112. --- RECORDSEPARATOR ---
  113. The windows will be listed in front-to-back order - the first window in the list will be 
  114. --- RECORDSEPARATOR ---
  115. the one at the front, while the last one in the list will be behind all other windows in 
  116. --- RECORDSEPARATOR ---
  117. the list.
  118. --- RECORDSEPARATOR ---
  119.  
  120. --- RECORDSEPARATOR ---
  121. See also:
  122. --- RECORDSEPARATOR ---
  123.  
  124. --- RECORDSEPARATOR ---
  125. baFindWindow 
  126. --- RECORDSEPARATOR ---
  127. baGetWindow